Skip to content

feat: Change installation namespace #556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

jaideepr97
Copy link
Contributor

@jaideepr97 jaideepr97 commented Jul 10, 2023

What type of PR is this?

Uncomment only one /kind line, and delete the rest.
For example, > /kind bug would simply become: /kind bug

/kind bug
/kind cleanup
/kind failing-test
/kind enhancement
/kind documentation
/kind code-refactoring

What does this PR do / why we need it:
Changes required for gitops-operator to be installed in its own namespace out of the box
Following changes are included:

  • change default namespace to openshift-gitops-operator
  • add cluster monitoring to new namespace
  • update control-plane label on all operator resources

Have you updated the necessary documentation?

  • Documentation update is required by this PR.
  • Documentation has been updated.

Which issue(s) this PR fixes:

Fixes #?

Test acceptance criteria:

  • Unit Test
  • E2E Test

How to test changes / Special notes to the reviewer:

@openshift-ci openshift-ci bot added the kind/enhancement New feature or request label Jul 10, 2023
@openshift-ci openshift-ci bot requested review from anandrkskd and varshab1210 July 10, 2023 12:25
Signed-off-by: Jaideep Rao <[email protected]>
@jaideepr97
Copy link
Contributor Author

/retest

1 similar comment
@jaideepr97
Copy link
Contributor Author

/retest

@@ -27,7 +27,7 @@ spec:

![a relative link](docs/assets/operatorhub-listing.png)

3. Install the operator using the defaults in the wizard, and wait for it to show up in the list of "Installed Operators". If it doesn't install properly, you can check on its status in the "Installed Operators" tab in the `openshift-operators` namespace.
3. Install the operator in the `openshift-gitops-operator` namesapce using the defaults in the wizard, and optionally, select the checkbox to enable cluster monitoring on the namesapce. Wait for it to show up in the list of "Installed Operators". If it doesn't install properly, you can check on its status in the "Installed Operators" tab in the `openshift-gitops-operator` namespace.
Copy link

@Srivaralakshmi Srivaralakshmi Jul 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jaideepr97 A few questions:

  • Do we have any possible installation failures and underlying causes or symptoms for the same? If yes, can we have troubleshooting tips for them?
  • If not installed properly, what status(es) are available to see for the user? Please provide doc inputs with the description of the statues (es). Also, provide information on what action the users must take for each of them.

Thanks!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jaideepr97 I see that the user has to just select/enable the OpenShift monitoring option while installing the GitOps Operator in the openshift-gitops-operator namespace.

  • Do we need any documentation or information like a concept/overview, or anything that we need in the Downstream documentation from the user's perspective, about monitoring metrics?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jaideepr97 Can you please respond to my queries here? Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Srivaralakshmi I don't know what the best place to put this info is so I'm just putting it here :

Installation instructions to be able to use this feature:

  • fresh installations of the operator will see the option to choose the namespace to install the operator in, with the recommended option already selected as openshift-gitops-operator namespace
  • users must select the check box saying Enable Operator recommended cluster monitoring on this Namespace to enable cluster monitoring

ns-installation

Usage instructions:

  • Once operator is installed, users can leverage the Observe > metrics page in the admin view to query the metrics exposed by the operator
  • At present the new operator performance metrics exposed are:
  • active_argocd_instances_total [Guage] - This metric produces the graph that tracks the total number of active argo-cd instances being managed by the operator at a given time
  • active_argocd_instances_by_phase{phase=<phase>} [Guage] - This metric produces the graph that tracks the count of active Argo CD instances by their phase [Available/Pending/Failed/unknown]
  • active_argocd_instance_reconciliation_count{namespace="<argocd-instance-ns>"} [Counter] - This metric produces the graph that tracks total number of reconciliations that have occurred for the instance in the given namespace at any given point in time
  • controller_runtime_reconcile_time_seconds_per_instance_bucket{namespace="<argocd-instance-ns>",le="0.5"} [Histogram]- This metric tracks the number of reconciliations that took under 0.5s to complete for a given instance

Any of these metrics can be queried against prometheus as described above, or can be used for more complex queries as is true with any other promql queries

reconciliations_per_instance
argocd_instances_by_phase
active_argocd_instances_total

@openshift-ci
Copy link

openshift-ci bot commented Jul 27, 2023

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from jaideepr97. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Signed-off-by: Jaideep Rao <[email protected]>
Signed-off-by: Jaideep Rao <[email protected]>
Signed-off-by: Jaideep Rao <[email protected]>
@iam-veeramalla
Copy link
Contributor

@jaideepr97 can you create the operator bundle and verify if the operator upgrade is working fine ?

Signed-off-by: Jaideep Rao <[email protected]>
@openshift-ci
Copy link

openshift-ci bot commented Sep 6, 2023

@jaideepr97: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/v4.10-kuttl-sequential 58fbf49 link true /test v4.10-kuttl-sequential
ci/prow/v4.10-kuttl-parallel 58fbf49 link true /test v4.10-kuttl-parallel
ci/prow/v4.11-kuttl-sequential 58fbf49 link true /test v4.11-kuttl-sequential
ci/prow/v4.11-kuttl-parallel 58fbf49 link true /test v4.11-kuttl-parallel
ci/prow/v4.14-kuttl-sequential-periodic 58fbf49 link true /test v4.14-kuttl-sequential-periodic
ci/prow/v4.14-e2e 5a223ae link true /test v4.14-e2e
ci/prow/v4.14-kuttl-parallel 5a223ae link true /test v4.14-kuttl-parallel
ci/prow/v4.14-kuttl-sequential 5a223ae link true /test v4.14-kuttl-sequential
ci/prow/v4.12-e2e 5a223ae link true /test v4.12-e2e
ci/prow/v4.13-e2e 5a223ae link true /test v4.13-e2e
ci/prow/v4.13-kuttl-parallel 3798e7f link true /test v4.13-kuttl-parallel
ci/prow/v4.13-kuttl-sequential 3798e7f link true /test v4.13-kuttl-sequential
ci/prow/v4.12-kuttl-parallel 3798e7f link true /test v4.12-kuttl-parallel
ci/prow/v4.12-kuttl-sequential 3798e7f link true /test v4.12-kuttl-sequential

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@iam-veeramalla
Copy link
Contributor

CI failures are expected as openshift/release repo should be updated for the CI changes to support this PR.

PR for openshift/release repo is created and will be merged once this PR is tested and passing the CI.
openshift/release#43023

@iam-veeramalla iam-veeramalla self-requested a review September 6, 2023 12:32
@iam-veeramalla iam-veeramalla merged commit a5e18ed into redhat-developer:master Sep 6, 2023
trdoyle81 pushed a commit to trdoyle81/gitops-operator that referenced this pull request Aug 13, 2024
…lation-namespace

feat: Change installation namespace
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants